home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 19 / Night Owl (The Best of Shareware)(NOPV 19)(1996).ISO / 007a / statsq3c.zip / CLEANUPQ.DOC < prev    next >
Text File  |  1996-01-01  |  10KB  |  198 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                              CleanUpQ for QFront (QSCAN)
  8.  
  9.           ═════════════════════════════════════════════════════════════════
  10.  
  11.               CleanUpQ does not run without the registration of StatusQ!
  12.  
  13.                CleanUpQ was written to reduce the size of the QFront log(s)
  14.           to speed up  the running of StatusQ as well  as reducing the size
  15.           of the QFront log(s) for editing, etc. This program is written to
  16.           be run  in conjunction with my  StatusQ program and is  not to be
  17.           run  as a  separate  program. To  do  so is  in  violation of  my
  18.           copyright. 
  19.  
  20.                This archive should contain the following files:
  21.  
  22.                CLEANUPQ.EXE.......... QFront log reduction utility
  23.                CLEANUPQ.DOC.......... Instructions for running CleanUpQ
  24.                DOORS.TXT............. Current list James Huckabey doors
  25.                FILE_ID.DIZ........... BBS description file
  26.                SOFTWARE.TXT.......... Information about shareware
  27.                HUCKABEY.TXT.......... Current list of all James Huckabey
  28.                                       software.
  29.                READ.ME............... Update/changes information
  30.                STATUSQ.EXE........... Actual program
  31.                STATUSQ.DOC........... Instructions for running StatusQ
  32.                STATUSQ.CFG........... Sample configuration file     
  33.                STATUSQ2.CFG.......... Sample configuration file
  34.                STATUSQ3.CFG.......... Sample configuration file
  35.                STATUSQ.LUP........... Sample networks line up file
  36.                ARCHIVE.TXT........... This list of files
  37.  
  38.  
  39.                                ******* WARNING *******
  40.  
  41.                A word of caution: Because garbage can get into any/all logs
  42.           it is possible to have CleanUpQ chop off your log with an invalid
  43.           end of file  marker. That is  the garbage can  contain a " "  and
  44.           CleanUpQ believes that  this is the end of the  file and cuts off
  45.           the  log at this  point. There is  no way to  program around this
  46.           problem. Once the marker  is found the file is set as the end and
  47.           no  way I can  work out  and over  come a  premature end  of file
  48.           marker. I am still trying to work this out.
  49.  
  50.                                   ******* o *******
  51.  
  52.  
  53.                Syntax:   CLEANUPQ [path]QSCAN.LOG [path][OTHER.CFG]
  54.  
  55.  
  56.                Where QSCAN.LOG is your QFront log file name.
  57.  
  58.                Where  [path][OTHER.CFG)   is  the  name  of   your  StatusQ
  59.           configuration  if you are not using 'STATUSQ.CFG' for the name of
  60.           the configuration file(s). If you do not  supply the name you use
  61.  
  62.  
  63.  
  64.  
  65.  
  66.           CleanUpQ aborts if it cannot find the default STATUSQ.CFG file.
  67.  
  68.                For best results CleanUpQ should be run before StatusQ. That
  69.           way  on the day of the rollover  the LOG(s) are at their smallest
  70.           possible size.  If  you run  CleanUpQ  a  second time  on  a  log
  71.           produced by rollover it does a hasty exit if the first date found
  72.           is the current date. No harm done!
  73.  
  74.                After  rollover you can run CleanUpQ on your previous log to
  75.           remove  the last day's activity.  To do this  you would unarchive
  76.           the rollover archive, run  CleanUpQ on your log(s) and  rearchive
  77.           the logs. This  way the  log only contains  conference names  and
  78.           Import  / Export totals with header (start date) and trailer (end
  79.           date). If you were  viewing previous activity this would  make it
  80.           much easier to read and total up. It would  be possible to make a
  81.           "Previous Month's" activity  bulletin out of the rolled over log.
  82.           At least the data would be all there and compacted.
  83.  
  84.                CleanUpQ must  be in current directory or  somewhere in your
  85.           path statement. You may include a  full name and path to your log
  86.           file. It removes  everything but the current  activity and writes
  87.           out  the   current  import   and  export  information   for  each
  88.           conference.
  89.  
  90.                At the end of activity the program displays the starting and
  91.           ending  log  file sizes,  starting  and  ending line  count.  The
  92.           process  may be lengthy  depending on  the size  of your  log. It
  93.           should be run  daily. All that  is needed to  run CleanUpQ is  as
  94.           much free space  on the log file drive as the  size of the log or
  95.           the program does not create a new log.
  96.  
  97.                If your BBS  system is critical  on free  space you can  run
  98.           CleanUpQ everyday to reduce  the size of your QFront  log(s). The
  99.           program removes unneeded  lines and does  nothing to the  current
  100.           day's portion  of the log. It stops processing data when it finds
  101.           the log date equal to the system date.
  102.  
  103.                If your hard drive space it not at a premium or speed is not
  104.           critical then  you really  do  not have  to run  CleanUpQ. Or  of
  105.           course  you want all information  to remain in  the log. The main
  106.           savings on time, both  CleanUpQ and StatusQ, would be  gained the
  107.           most  near month's  end. It  takes StatusQ  time to  read in  and
  108.           process logs when they are larger. Lines can reach 18,000 or more
  109.           on a system with a lot of conferences and/or messages.
  110.  
  111.                What CleanUpQ does is  read in all lines separating  out the
  112.           conference names  and number of messages  per conference (running
  113.           total  for each conference). When  the program finds  the date in
  114.           the log matches the system date, or reaches end of log, it starts
  115.           writing  out   the  conference  names  and   total  messages  per
  116.           conference  to a new  log. If it  has found today's  date then it
  117.           appends  the  rest of  the  current  data to  the  new log.  When
  118.           finished it erases the old log.
  119.  
  120.  
  121.  
  122.  
  123.  
  124.                This leaves you  with a new log showing  only the totals per
  125.           conference,  in sorted order, then the start of the current day's
  126.           activity (unaltered). CleanUpQ only needs to be run once per day.
  127.           If you  run it  additional times  nothing is  changed in  the log
  128.           although  it  does keep  writing out  a  new one.  Any additional
  129.           information  written to the log  will not be  processed until the
  130.           next day.
  131.  
  132.                If the month rolls over in the log CleanupQ does nothing and
  133.           exits immediately. StatusQ then does the rollover during it's own
  134.           activities.
  135.  
  136.                Regardless of  what is deleted the  current day's activities
  137.           are not altered in any way (unless premature end of file marker).
  138.  
  139.  
  140.                    Special Bulletins Showing Totals Each Conference
  141.  
  142.                It  is  possible  to  make  a  "Previous  Month's"  activity
  143.           bulletin out of  the rolled over log(s). At least  the data would
  144.           be all there and compacted. All you have to do is make a  special
  145.           STATUSQ.CFG file with the name of the bulletins for these special
  146.           monthly Bulletins. You could  do one each month for  the previous
  147.           month. The  bulletin for the Last Import could just be written to
  148.           the  current directory  and  not  used.  For  a  full  month  the
  149.           Bulletins would have something like  01-01-95 to 01-31-95 for the
  150.           time period as this would be the dates in a log for January 1995.
  151.  
  152.                Of course  the above  would work  even  if you  did not  run
  153.           CleanUpQ.
  154.  
  155.  
  156.                                      This Program
  157.  
  158.                If you don't like the program please write to me and explain
  159.           why. Send me any  suggestions you might have. If they enhance the
  160.           overall program I will try to incorporate part, some, all, in the
  161.           next release.
  162.  
  163.  
  164.                                         Errors
  165.  
  166.                Errors are written to the current directory in a file called
  167.           CLEANUPQ.ERR. If  the file  already exists additional  errors are
  168.           appended to the end of the file. It may be deleted after you have
  169.           made note  of any errors. It's  existence it not  required by the
  170.           program.  Current  directory is  wherever  you  call CLEANUPQ.EXE
  171.           from.
  172.  
  173.                CleanUpQ must  find a registered copy  of STATUSQ.EXE either
  174.           in  the  current  directory,  path  or  set  in  the  environment
  175.           according  to the  StatusQ documentation.  CleanUpQ reads  in the
  176.           STATUSQ.CFG file, or optional  command line configuration file. I
  177.           did this because  some people might want  to run this program  on
  178.  
  179.  
  180.  
  181.  
  182.  
  183.           their log file without having StatusQ on their system. This is in
  184.           violation  of  my copyrights.  This program  can  only be  run in
  185.           conjunction with STATUSQ.EXE. 
  186.  
  187.                CLEANUPQ.EXE  or any of the  other files in  the archive may
  188.           not  be distributed in any  form other than  the original archive
  189.           and unaltered.
  190.  
  191.                Please  support  my  efforts  and  register  StatusQ,  which
  192.           includes  making  CleanUpQ   operational.  See  STATUSQ.DOC   for
  193.           details.
  194.  
  195.                James Huckabey
  196.                3621-A Fraser Street
  197.                Bellingham, Washington 98226-2473 U.S.A.
  198.                (360) 671-2868 (voice, Pacific)